<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>printf</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="print.html" title="print" />
    <link rel="next" href="printk2.html" title="printk2" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">printf</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="print.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="printk2.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="printf"></a>
      <div class="titlepage"></div>
      <a id="Indexprintf_i" class="indexterm"></a>
      <a id="Indexprintf" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">printf</span>
        </h2>
        <p>printf — 
      printf-style formatted output
    </p>
      </div>
      <div class="refsect1">
        <a id="idp135738576"></a>
        <h2>Description</h2>
        <p>
      <span class="command"><strong>printf</strong></span> and <span class="command"><strong>printf_i</strong></span> write
    formatted output, similarly to the C function
    printf(). <span class="command"><strong>printf_i</strong></span> runs at i-time only, while
    <span class="command"><strong>printf</strong></span> runs both at initialization and
    performance time. 
    </p>
      </div>
      <div class="refsect1">
        <a id="idp135809744"></a>
        <h2>Syntax</h2>
        <pre class="synopsis"><span class="command"><strong>printf_i</strong></span> Sfmt, itrig, [iarg1[, iarg2[, ... ]]]</pre>
        <pre class="synopsis"><span class="command"><strong>printf</strong></span> Sfmt, ktrig, [xarg1[, xarg2[, ... ]]]</pre>
      </div>
      <div class="refsect1">
        <a id="idp135812976"></a>
        <h2>Initialization</h2>
        <p>
      <span class="emphasis"><em>Sfmt</em></span> -- format string, has the same format
    as in printf() and other similar C functions, except length
    modifiers (l, ll, h, etc.) are not supported. The following
    conversion specifiers are allowed: 
      </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem">
              <p>d, i, o, u, x, X, e, E, f, F, g, G, c, s</p>
            </li>
          </ul>
        </div>
        <p>
    </p>
        <p>
      <span class="emphasis"><em>iarg1, iarg2, ...</em></span> -- input arguments
      (max. 30) for format.  Integer formats like %d round the input
      values to the nearest integer. 
    </p>
        <p>
      <span class="emphasis"><em>itrig</em></span> -- if greater than zero the opcode
    performs the printing; otherwise it is an null operation.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp135817872"></a>
        <h2>Performance</h2>
        <p>
      <span class="emphasis"><em>ktrig</em></span> -- if greater than zero and different
    from the value on the previous control cycle the opcode
    performs the requested printing.  Initially this previous value is
    taken as zero.
    </p>
        <p>
      <span class="emphasis"><em>xarg1, xarg2, ...</em></span> -- input arguments
    (max. 30) for format.  Integer formats like %d round the input
    values to the nearest integer. Note that only k-rate and i-rate arguments are valid (no a-rate printing)
    </p>
      </div>
      <div class="refsect1">
        <a id="idp135820704"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the printf opcode. It uses the file <a class="ulink" href="examples/printf.csd" target="_top"><em class="citetitle">printf.csd</em></a>.
      </p>
        <div class="example">
          <a id="idp135822560"></a>
          <p class="title">
            <strong>Example 650. Example of the printf opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
-odac     <span class="comment">;;;realtime audio out</span>
<span class="comment">;-iadc    ;;;uncomment -iadc if realtime audio input is needed too</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">;-o printf.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>

<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">ksmps</span> <span class="op">=</span> 32
<span class="ohdr">nchnls</span> <span class="op">=</span> 2
<span class="ohdr">0dbfs</span>  <span class="op">=</span> 1

<span class="oblock">instr</span> 1
Sfile     <span class="opc">strget</span>    p4
ivld      <span class="opc">filevalid</span> Sfile

<span class="octrl">if</span> ivld<span class="op">=</span>0 then
          <span class="opc">printf_i</span>  "Audiofile '<span class="op">%</span>s' does not exist!\n", 1, Sfile
<span class="octrl">else</span>
asig      <span class="opc">diskin2</span>   Sfile, 1
          <span class="opc">outs</span>      asig, asig
<span class="octrl">endif</span>

<span class="oblock">endin</span>

<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>

<span class="stamnt">i</span> 1 0 3 "frox.wav"<span class="comment">;file does not exist!!!</span>
<span class="stamnt">i</span> 1 + 3 "fox.wav"<span class="comment">;but this one certainly does...</span>

<span class="stamnt">e</span>
<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
        <p>
      The example will produce the following output:
      </p>
        <pre class="screen">
Audiofile 'frox.wav' does not exist!
      </pre>
        <p>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp135828000"></a>
        <h2>See Also</h2>
        <p>
</p>
        <p> More information about printf: <a class="ulink" href="http://www.cplusplus.com/reference/clibrary/cstdio/printf/" target="_top"><em class="citetitle">http://www.cplusplus.com/reference/clibrary/cstdio/printf/</em></a></p>
        <p>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp135830368"></a>
        <h2>Credits</h2>
        <p>
      </p>
        <table border="0" summary="Simple list" class="simplelist">
          <tr>
            <td>Author: Istvan Varga</td>
          </tr>
          <tr>
            <td>2005</td>
          </tr>
        </table>
        <p>
    </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="print.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="printk2.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">print </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> printk2</td>
        </tr>
      </table>
    </div>
  </body>
</html>
